home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / comm / record21.zip / RECORD.DOC < prev    next >
Text File  |  1994-04-09  |  15KB  |  384 lines
  1.  
  2.                               **** RECORD ****
  3.  
  4.                        A SALT Script Creator for Telix
  5.                                  Version 2.1
  6.  
  7.                                      by
  8.                                Mark P. Harrison
  9.                        Documentation by: Chris Johnson
  10.                                   04/09/94
  11.  
  12.         Copyright 1993,94 by Mark P. Harrison. All Rights Reserved.
  13.  
  14.  
  15.         ─────────────
  16.         LEGAL NOTICE:
  17.         ─────────────
  18.  
  19.         RECORD is a Shareware product. It is NOT freeware or public
  20.         domain.  If you use RECORD you are expected to pay for it.
  21.         You can register RECORD at a cost of $10.00 (U.S. currency).
  22.         In return for your registration, you will be provided a key
  23.         to remove the Exit Screen and other unregistered reminders
  24.         from this and any future versions.
  25.  
  26.         RECORD IS PROVIDED ON AN "AS IS" BASIS WITHOUT WARRANTY OF ANY
  27.         KIND EXPRESSED OR IMPLIED. IN NO EVENT WILL MARK P. HARRISON BE
  28.         LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST
  29.         SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT
  30.         OF THE USE OF OR INABILITY TO USE THE PROGRAM, EVEN IF MARK P.
  31.         HARRISON HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR
  32.         FOR ANY CLAIM BY ANY OTHER PARTY.
  33.  
  34.         RECORD is a trademark of Mark P. Harrison
  35.  
  36.         SALT and Telix are trademarks of deltaComm Development.
  37.         Use of Telix(tm) for longer than 45 days without appropriate
  38.         payment to deltaComm Development for Telix is a violation of
  39.         international Copyright Law.
  40.  
  41.  
  42.         ────────────
  43.         Packing List
  44.         ────────────
  45.  
  46.           RECORD.SLC        15204      The RECORD Script Itself
  47.           RECORD.DOC        15372      This Documentation File
  48.           HISTORY.TXT       2429       Version History
  49.           REGISTER.TXT      2545       Registration Form
  50.           FILE_ID.DIZ       346        Description File
  51.  
  52.  
  53.         ──────────────────────────
  54.         Note to CompuServe Users's
  55.         ──────────────────────────
  56.  
  57.         If you downloaded RECORD from CompuServe, Please rename the
  58.         archive RECORD21.ZIP before uploading it anywhere.
  59.  
  60.  
  61.  
  62.         ──────────────────────────
  63.         Features/Fixes New to V2.1
  64.         ──────────────────────────
  65.  
  66.         *   RECORD can now edit your dialing directory with your new
  67.             linked script name if the record/compile session was
  68.             successful.
  69.  
  70.         *   You can now record keys at a blank screen (needed to
  71.             "wake up" some systems).
  72.  
  73.         *   You can now record turning the Telix capture file on/off
  74.  
  75.         *   Numbers can now be entered from the numeric keypad.
  76.  
  77.         *   The number of Prompt/Answer pairs allowed has been
  78.             increased.
  79.  
  80.         *   1 character prompts are now supported. (This was causing
  81.             double prompts to be written into the script).
  82.  
  83.         *   Added Carrier check to the WAIT() function to end the script
  84.             sooner if you get disconnected.
  85.  
  86.  
  87.         ───────────────
  88.         SPECIAL THANKS:
  89.         ───────────────
  90.  
  91.         There are several people I would like to thank for helping
  92.         make this version of RECORD what it is:
  93.  
  94.         Chris Johnson for the documentation.
  95.  
  96.         Phil Crown for the dialing directory code segment.
  97.  
  98.         Jerry Miller for extensive testing with blank screens.
  99.  
  100.         Crawford Dales for tracking down an odd bug.
  101.  
  102.         All of my registered users for their money <G>
  103.         and great suggestions on things to add.
  104.  
  105.         YOU for taking the time to give RECORD a try.
  106.  
  107.  
  108.  
  109.         ───────────────
  110.         What is RECORD?
  111.         ───────────────
  112.  
  113.         RECORD is a script written entirely in the Script Application
  114.         Language for Telix (SALT).  Its function is to automate the
  115.         process of logging on to bulletin boards (and other systems),
  116.         perform a desired task(s) and then log off. RECORD frees the
  117.         user from making keystrokes by doing routine tasks faster, saving
  118.         time and money.
  119.  
  120.  
  121.         ─────────────────
  122.         How Does it Work?
  123.         ─────────────────
  124.  
  125.         As its name suggests, RECORD makes an exact copy of the
  126.         functions you perform as you interact online with a BBS.  It
  127.         keeps track of the prompts sent by the BBS, in addition to
  128.         the user's responses.  Once the session has ended, RECORD then
  129.         invokes the SALT compiler to create an executable file.  The
  130.         name of this file will be placed in the Telix dialing directory
  131.         as a "linked script" which will be automatically run when the
  132.         selected dialing directory entry establishes a connection.
  133.  
  134.             NOTE:  When a BBS makes changes to their online
  135.                    prompts your RECORD script will obviously
  136.                    fail.  When this happens, RECORD will tell
  137.                    you what prompt it was expecting so you
  138.                    will know what caused the failure.  To fix
  139.                    this problem simply create a new script.
  140.  
  141.  
  142.         ────────────────────────────
  143.         What Can a RECORD Script Do?
  144.         ────────────────────────────
  145.  
  146.         RECORD scripts can be used for uploads and/or downloads.  For
  147.         example, you can upload a mail packet reply and download new
  148.         messages in the same RECORD session.  Only one upload is
  149.         permitted, but it can be a batch upload if you are using a
  150.         protocol that supports batch uploading.
  151.  
  152.             NOTE:  If you choose, RECORD can delete a successfully
  153.                    uploaded file.   This feature does not work for
  154.                    batch uploads.
  155.  
  156.         Scripts created with RECORD now have the ability to turn on and
  157.         off the Telix Capture File feature.  This feature can be very
  158.         useful for getting specific information from a BBS that is only
  159.         displayed on the screen.
  160.  
  161.  
  162.  
  163.         ─────────────────
  164.         Installing RECORD
  165.         ─────────────────
  166.  
  167.         This documentation assumes you are currently running Telix and
  168.         have completed all the necessary configurations (Alt-O) to
  169.         perform file transfers.  It is also assumed that you understand
  170.         the basics of editing the dialing directory, specifically the
  171.         "Linked Script" entry.  If any of the above seems a little
  172.         fuzzy, consult your Telix manual.
  173.  
  174.         1.__  Copy RECORD21.ZIP to your Telix defined script
  175.               directory,  Ex. c:\telix\scripts\ <-note trailing "\".
  176.               CS.EXE, the SALT compiler that comes with Telix must be
  177.               present in the same directory.
  178.  
  179.         2.__  Unzip RECORD21.ZIP. If you have a prior version of any of
  180.               these files present, you will be prompted if you want
  181.               them overwritten. You must answer yes to update your files.
  182.  
  183.         3.__  That's all there is to it!
  184.  
  185.  
  186.         ──────────────────
  187.         RECORDing a Script
  188.         ──────────────────
  189.  
  190.         Here are the steps for creating a RECORD script.  Since every
  191.         script is different, only the steps for logging on, compiling,
  192.         naming and defining the script are discussed.  What you do in
  193.         between is your own business. [g]
  194.  
  195.         1.__  With Telix running, <Press>Alt-D to call up the dialing
  196.               directory.
  197.  
  198.         2.__  <Highlight>an entry and <Press>E to edit.
  199.  
  200.         3.__  <Press>Enter until the "Linked Script" field is
  201.               highlighted, then <Type>RECORD
  202.  
  203.         4.__  <Press>Enter to save your entry and then exit the
  204.               edit screen by continuing to <Press>Enter until the
  205.               edit screen closes.
  206.  
  207.         5.__  <Press>D to make the call.
  208.  
  209.             **If the BBS you are calling requires you to enter one or
  210.               two Escapes when you connect, just <Press>Esc once.  The
  211.               second Esc will be entered for you.
  212.  
  213.             **If the BBS starts with a blank screen, <Press>Enter (or
  214.               whatever is required to wake it up.
  215.  
  216.  
  217.  
  218.         ──────────────────
  219.         RECORDing a Script - continued
  220.         ──────────────────
  221.  
  222.             **If you have a password defined in your Telix dialing
  223.               directory, you can <Press>F1 to send it.
  224.               (Note: you cannot send your name or password using
  225.               HotKey macros or via scripts, you must type your name.)
  226.  
  227.             **If you are planning to record an upload you must know the
  228.               "Key" letter for the protocol you plan to use.
  229.  
  230.             **If you are planning to record a download, you must have
  231.               the protocol set up to auto-download.
  232.  
  233.         6__  When you have finished with the steps you wish to automate,
  234.              hit Alt-X and a screen similar to the one below will appear:
  235.              (Except the REGISTERED TO:  and Input SCRIPT name: fields
  236.              will be different.)
  237.  
  238.              ╔══════════════════╡ RECORD v2.1 ╞══════════════════╗
  239.              ║                                                   ║
  240.              ║           REGISTERED TO: YOUR NAME                ║
  241.              ║                                                   ║
  242.              ║          Input SCRIPT name: YOURBBS .SLT          ║
  243.              ║                                                   ║
  244.              ║  (Hit ESCAPE to abort or ENTER to keep default.)  ║
  245.              ╚═══════════════════════════════════════════════════╝
  246.  
  247.              You now have three options:
  248.  
  249.                 - <Press>Esc to abort the script.
  250.  
  251.                 - <Press>Enter to save the name RECORD has displayed.
  252.  
  253.                 - <Type>another DOS filename for your script.
  254.  
  255.  
  256.         7__  If you saved the script, RECORD will ask:
  257.  
  258.              ╔════════════════════════════════════════════════════╗
  259.              ║                                                    ║
  260.              ║ Do you want to compile your new script now? Yes/No ║
  261.              ║                                                    ║
  262.              ╚════════════════════════════════════════════════════╝
  263.  
  264.         Answer "Yes" to compile the script now (recommended) or "No" to
  265.         do it later.
  266.  
  267.  
  268.  
  269.         ──────────────────
  270.         RECORDing a Script - continued
  271.         ──────────────────
  272.  
  273.         8__  RECORD user's will now be glad to know that it is no longer
  274.              necessary to manually edit their dialing directories with
  275.              the new script's name.  RECORD will now ask:
  276.  
  277.              ╔════════════════════════════════════════════════════╗
  278.              ║                                                    ║
  279.              ║ Do you want this as your linked script now? Yes/No ║
  280.              ║                                                    ║
  281.              ╚════════════════════════════════════════════════════╝
  282.  
  283.         If you answer "Yes" to the above prompt, RECORD will show:
  284.  
  285.              ╔══════════════════╡ RECORD v2.1 ╞══════════════════╗
  286.              ║                                                   ║
  287.              ║           REGISTERED TO: YOUR NAME                ║
  288.              ║                                                   ║
  289.              ║            Input FON name:  TELIX   .FON          ║
  290.              ║                                                   ║
  291.              ║  (Hit ESCAPE to abort or ENTER to keep default.)  ║
  292.              ╚═══════════════════════════════════════════════════╝
  293.  
  294.         This works the same as naming your compiled script.  The
  295.         .FON directory shown defaults to either TELIX.FON, or the
  296.         directory used the last time you used RECORD. You have the
  297.         option to abort, save or name another .FON directory.
  298.  
  299.  
  300.         ────────────────────────────────
  301.         Using Screen Capture with RECORD
  302.         ────────────────────────────────
  303.  
  304.         RECORD now supports the Alt-L Capture toggle function of Telix.
  305.         This can be very handy for automating sessions to get such
  306.         things as weather reports, BBS bulletins, or even messages.
  307.  
  308.         You need to be aware of a few rules when using capture:
  309.  
  310.         1.  Your capture file begins with the last prompt you answered
  311.             before you turned it on. (You might get a little extra data.)
  312.  
  313.         2.  After you have captured the data you want, you must answer
  314.             one more prompt BEFORE you turn it off. (You might not get
  315.             all the data you wanted.)
  316.  
  317.         3.  If you want to capture data all the way up to your normal
  318.             logoff, RECORD will close the capture for you.
  319.  
  320.  
  321.  
  322.         ─────────────
  323.         REGISTRATION:
  324.         ─────────────
  325.  
  326.         If you experience a problem or if you have a suggestion  for an
  327.         improvement and/or addition to this script feel free to write me.
  328.         ┌──────────────────────────────┐
  329.         │   Mark P. Harrison           │
  330.         │   6676 Robinson School Rd.   │
  331.         │   New Athens, IL 62264   USA │
  332.         │   FidoNet: Telix Echo        │
  333.         │   FidoNet: 1:2250/23         │
  334.         │   BBS: (618)539-6254         │
  335.         └──────────────────────────────┘
  336.         There is a fee of $10.00 (US) for the use of this script.
  337.  
  338.         If you find this script useful, please complete the form below
  339.         and send it along with your payment to the above address. In
  340.         return for the $10 registration fee, you will receive a key to
  341.         remove the exit screen and brand your name as registered in
  342.         this AND any future versions. I encourage you to pass this script
  343.         around to your friends. Thank you for your support.
  344.                                             ╓╥╥╖    ╓╖ ╓
  345.                                              ║║║ARK  ╟─╢ARRISON
  346.                                              ╜ ╙─────╜ ╙────────o
  347.  
  348.                                ** RECORD **
  349.                                    v2.1
  350.                              REGISTRATION FORM
  351.  
  352.  
  353.         SHIP TO NAME:_______________________________________________
  354.  
  355.              ADDRESS:_______________________________________________
  356.  
  357.                      _______________________________________________
  358.  
  359.                      _______________________________________________
  360.  
  361.  
  362.         REGISTER TO:
  363.         ┌─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┬─┐
  364.         │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
  365.         └─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┴─┘
  366.         (This is what you want to appear on your registered copy.)
  367.                                 (30 Max.)
  368.  
  369.         Where did you hear about RECORD? ____________________________
  370.  
  371.         Where did you get your copy of RECORD? ______________________
  372.  
  373.         Voice Phone: _________________  BBS Phone: __________________
  374.          (Optional)
  375.  
  376.         FIDO NetMail address if you have one: _______________________
  377.  
  378.         Comments:____________________________________________________
  379.  
  380.                  ____________________________________________________
  381.  
  382.                  ____________________________________________________
  383.  
  384.